# -*- coding: utf-8 -*-

# Created on 06/08/2010

# Copyright (C) 2010  Sergio Rodrigo

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


class Action:
    """ Allows to store an action used in the game.
    
    * Methods:
    __init__(self, _type, _name, _value, _magnitude)
    
    * Member variables:
    type_ -- String Action type
    name -- String Action name
    value -- String Action value
    magnitude -- Float Action magnitude
    
    """
    
    def __init__(self, type_, name, value, magnitude):
        """ Constructor.
        
        * Arguments:
        type_ -- String Action type (default "")
        name -- String Action name (default "")
        value -- String Action value (default "")
        magnitude -- Float Action magnitude (default 0.0)
        
        """
        self.type = type_
        self.name = name
        self.value = value
        self.magnitude = magnitude

# eof
